<!doctype html>

<html>
<head>
  <link rel="shortcut icon" href="static/images/favicon.ico" type="image/x-icon">
  <title>decoratormatcher.js (Closure Library API Documentation - JavaScript)</title>
  <link rel="stylesheet" href="static/css/base.css">
  <link rel="stylesheet" href="static/css/doc.css">
  <link rel="stylesheet" href="static/css/sidetree.css">
  <link rel="stylesheet" href="static/css/prettify.css">

  <script>
     var _staticFilePath = "static/";
     var _typeTreeName = "goog";
     var _fileTreeName = "Source";
  </script>

  <script src="static/js/doc.js">
  </script>


  <meta charset="utf8">
</head>

<body onload="grokdoc.onLoad();">

<div id="header">
  <div class="g-section g-tpl-50-50 g-split">
    <div class="g-unit g-first">
      <a id="logo" href="index.html">Closure Library API Documentation</a>
    </div>

    <div class="g-unit">
      <div class="g-c">
        <strong>Go to class or file:</strong>
        <input type="text" id="ac">
      </div>
    </div>
  </div>
</div>

<div class="clear"></div>

<h2><a href="closure_goog_labs_testing_decoratormatcher.js.html">decoratormatcher.js</a></h2>

<pre class="prettyprint lang-js">
<a name="line1"></a>// Copyright 2012 The Closure Library Authors. All Rights Reserved.
<a name="line2"></a>//
<a name="line3"></a>// Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);
<a name="line4"></a>// you may not use this file except in compliance with the License.
<a name="line5"></a>// You may obtain a copy of the License at
<a name="line6"></a>//
<a name="line7"></a>//      http://www.apache.org/licenses/LICENSE-2.0
<a name="line8"></a>//
<a name="line9"></a>// Unless required by applicable law or agreed to in writing, software
<a name="line10"></a>// distributed under the License is distributed on an &quot;AS-IS&quot; BASIS,
<a name="line11"></a>// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<a name="line12"></a>// See the License for the specific language governing permissions and
<a name="line13"></a>// limitations under the License.
<a name="line14"></a>
<a name="line15"></a>/**
<a name="line16"></a> * @fileoverview Provides the built-in decorators: is, describedAs, anything.
<a name="line17"></a> */
<a name="line18"></a>
<a name="line19"></a>
<a name="line20"></a>
<a name="line21"></a>goog.provide(&#39;goog.labs.testing.AnythingMatcher&#39;);
<a name="line22"></a>
<a name="line23"></a>
<a name="line24"></a>goog.require(&#39;goog.labs.testing.Matcher&#39;);
<a name="line25"></a>
<a name="line26"></a>
<a name="line27"></a>
<a name="line28"></a>/**
<a name="line29"></a> * The Anything matcher. Matches all possible inputs.
<a name="line30"></a> *
<a name="line31"></a> * @constructor
<a name="line32"></a> * @implements {goog.labs.testing.Matcher}
<a name="line33"></a> */
<a name="line34"></a>goog.labs.testing.AnythingMatcher = function() {};
<a name="line35"></a>
<a name="line36"></a>
<a name="line37"></a>/**
<a name="line38"></a> * Matches anything. Useful if one doesn&#39;t care what the object under test is.
<a name="line39"></a> *
<a name="line40"></a> * @override
<a name="line41"></a> */
<a name="line42"></a>goog.labs.testing.AnythingMatcher.prototype.matches =
<a name="line43"></a>    function(actualObject) {
<a name="line44"></a>  return true;
<a name="line45"></a>};
<a name="line46"></a>
<a name="line47"></a>
<a name="line48"></a>/**
<a name="line49"></a> * This method is never called but is needed so AnythingMatcher implements the
<a name="line50"></a> * Matcher interface.
<a name="line51"></a> *
<a name="line52"></a> * @override
<a name="line53"></a> */
<a name="line54"></a>goog.labs.testing.AnythingMatcher.prototype.describe =
<a name="line55"></a>    function(actualObject) {
<a name="line56"></a>  throw Error(&#39;AnythingMatcher should never fail!&#39;);
<a name="line57"></a>};
<a name="line58"></a>
<a name="line59"></a>
<a name="line60"></a>/**
<a name="line61"></a> * Returns a matcher that matches anything.
<a name="line62"></a> *
<a name="line63"></a> * @return {!goog.labs.testing.AnythingMatcher} A AnythingMatcher.
<a name="line64"></a> */
<a name="line65"></a>function anything() {
<a name="line66"></a>  return new goog.labs.testing.AnythingMatcher();
<a name="line67"></a>}
<a name="line68"></a>
<a name="line69"></a>
<a name="line70"></a>/**
<a name="line71"></a> * Returnes any matcher that is passed to it (aids readability).
<a name="line72"></a> *
<a name="line73"></a> * @param {!goog.labs.testing.Matcher} matcher A matcher.
<a name="line74"></a> * @return {!goog.labs.testing.Matcher} The wrapped matcher.
<a name="line75"></a> */
<a name="line76"></a>function is(matcher) {
<a name="line77"></a>  return matcher;
<a name="line78"></a>}
<a name="line79"></a>
<a name="line80"></a>
<a name="line81"></a>/**
<a name="line82"></a> * Returns a matcher with a customized description for the given matcher.
<a name="line83"></a> *
<a name="line84"></a> * @param {string} description The custom description for the matcher.
<a name="line85"></a> * @param {!goog.labs.testing.Matcher} matcher The matcher.
<a name="line86"></a> *
<a name="line87"></a> * @return {!goog.labs.testing.Matcher} The matcher with custom description.
<a name="line88"></a> */
<a name="line89"></a>function describedAs(description, matcher) {
<a name="line90"></a>  matcher.describe = function(value) {
<a name="line91"></a>    return description;
<a name="line92"></a>  };
<a name="line93"></a>  return matcher;
<a name="line94"></a>}
</pre>


</body>
</html>
